Add --env-cwd Option To wp-env run
#49908
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This option allows `wp-env run` to execute from a different working directory. This is nice for relative paths
noahtallen
reviewed
Apr 19, 2023
There was a problem hiding this comment.
I wonder if it'd be worthwhile to allow the input to be relative from the WordPress root to reduce noise? E.g. by default, it's resolved from /var/www/html, and then an input of --env-cwd=wp-content/plugins/gutenberg would work. (And if you prefix with "/", it would just pass it directly). I think we could do this with path.resolve
|
I agree @noahtallen, it makes more sense to use relative paths. I can't really imagine anyone ever using anything other than |
noahtallen
reviewed
Apr 19, 2023
noahtallen
reviewed
Apr 20, 2023
noahtallen
approved these changes
Apr 20, 2023
Co-authored-by: Noah Allen <noahtallen@gmail.com>
|
Thanks @noahtallen! 🚢 |
noahtallen
added
[Tool] Env
bph
added
[Type] Enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
By default all
wp-env runcommands are ran from/var/www/html. This means that any relative paths used in a command are relative to this directory. This PR adds a new--env-cwdoption that changes the working directory forwp-env run.Why?
In adding support for running PHPUnit tests to our repository, I noticed that running
wp-env run tests-wordpress /var/www/html/wp-content/plugins/woocommerce/vendor/bin/phpunitin a script and adding a path to a test file does not work. It expects the relative path to be relative to/var/www/htmlinstead of thephpunit.xmlfile I use.As for the name
--env-cwd, it's important to note that any options registered bynpmorwp-envare consumed by their respective tools instead of being passed on.--cwdseems likely to have been used by some tool, so, we should try and avoid conflict.I've marked this as a breaking change in case someone is using
--env-cwdin theirwp-env runcommands. Since it's going to consume it there's the possibility it will break for someone.How?
We're using the
-woption provided bydocker-compose runto change the working directory of the command. This avoids any messiness with trying tocd.Testing Instructions
npm run env -- run tests-wordpress pwdshould echo/var/www/html.npm run env -- run tests-wordpress --env-cwd=/var pwdshould echo/var.